<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>SPHinXsys: SPH::PeriodicConditionInAxisDirectionUsingGhostParticles Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">SPHinXsys
   &#160;<span id="projectnumber">alpha version</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespace_s_p_h.html">SPH</a></li><li class="navelem"><a class="el" href="class_s_p_h_1_1_periodic_condition_in_axis_direction_using_ghost_particles.html">PeriodicConditionInAxisDirectionUsingGhostParticles</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="class_s_p_h_1_1_periodic_condition_in_axis_direction_using_ghost_particles-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">SPH::PeriodicConditionInAxisDirectionUsingGhostParticles Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>The method imposing periodic boundary condition in an axis direction by using ghost particles. It includes three different steps, i.e. imposing periodic bounding, creating ghosts and update ghost state. The first step is carried out before update cell linked list and the second and third after the updating. If the exec or parallel_exec is called directly, error message will be given. Note that, currently, this class is not for periodic condition in combined directions, such as periodic condition in both x and y directions.  
 <a href="class_s_p_h_1_1_periodic_condition_in_axis_direction_using_ghost_particles.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="general__dynamics_8h_source.html">general_dynamics.h</a>&gt;</code></p>

<p>Inherits <a class="el" href="class_s_p_h_1_1_periodic_condition_in_axis_direction.html">SPH::PeriodicConditionInAxisDirection</a>.</p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_h_1_1_periodic_condition_in_axis_direction_using_ghost_particles_1_1_creat_periodic_ghost_particles.html">CreatPeriodicGhostParticles</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">create ghost particles in an axis direction  <a href="class_s_p_h_1_1_periodic_condition_in_axis_direction_using_ghost_particles_1_1_creat_periodic_ghost_particles.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_h_1_1_periodic_condition_in_axis_direction_using_ghost_particles_1_1_update_periodic_ghost_particles.html">UpdatePeriodicGhostParticles</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">update ghost particles in an axis direction  <a href="class_s_p_h_1_1_periodic_condition_in_axis_direction_using_ghost_particles_1_1_update_periodic_ghost_particles.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a53a1b40e878b8ebb28810f569968556d"><td class="memItemLeft" align="right" valign="top"><a id="a53a1b40e878b8ebb28810f569968556d"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>PeriodicConditionInAxisDirectionUsingGhostParticles</b> (<a class="el" href="class_s_p_h_1_1_real_body.html">RealBody</a> *real_body, <a class="el" href="classint.html">int</a> axis_direction)</td></tr>
<tr class="separator:a53a1b40e878b8ebb28810f569968556d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_class_s_p_h_1_1_periodic_condition_in_axis_direction"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_s_p_h_1_1_periodic_condition_in_axis_direction')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_s_p_h_1_1_periodic_condition_in_axis_direction.html">SPH::PeriodicConditionInAxisDirection</a></td></tr>
<tr class="memitem:a582ed552b11b748b3d8f77a2563d5631 inherit pub_methods_class_s_p_h_1_1_periodic_condition_in_axis_direction"><td class="memItemLeft" align="right" valign="top"><a id="a582ed552b11b748b3d8f77a2563d5631"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>PeriodicConditionInAxisDirection</b> (<a class="el" href="class_s_p_h_1_1_real_body.html">RealBody</a> *real_body, <a class="el" href="classint.html">int</a> axis_direction)</td></tr>
<tr class="separator:a582ed552b11b748b3d8f77a2563d5631 inherit pub_methods_class_s_p_h_1_1_periodic_condition_in_axis_direction"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:ad6b07dbf477c8c9c0ece63f3af493e9d"><td class="memItemLeft" align="right" valign="top"><a id="ad6b07dbf477c8c9c0ece63f3af493e9d"></a>
<a class="el" href="class_periodic_bounding.html">PeriodicBounding</a>&#160;</td><td class="memItemRight" valign="bottom"><b>bounding_</b></td></tr>
<tr class="separator:ad6b07dbf477c8c9c0ece63f3af493e9d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a57f155fc25aaa4a0356a4e53ec92773a"><td class="memItemLeft" align="right" valign="top"><a id="a57f155fc25aaa4a0356a4e53ec92773a"></a>
<a class="el" href="class_s_p_h_1_1_periodic_condition_in_axis_direction_using_ghost_particles_1_1_creat_periodic_ghost_particles.html">CreatPeriodicGhostParticles</a>&#160;</td><td class="memItemRight" valign="bottom"><b>ghost_creation_</b></td></tr>
<tr class="separator:a57f155fc25aaa4a0356a4e53ec92773a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a303195ab5897d14ed598d29afd467f72"><td class="memItemLeft" align="right" valign="top"><a id="a303195ab5897d14ed598d29afd467f72"></a>
<a class="el" href="class_s_p_h_1_1_periodic_condition_in_axis_direction_using_ghost_particles_1_1_update_periodic_ghost_particles.html">UpdatePeriodicGhostParticles</a>&#160;</td><td class="memItemRight" valign="bottom"><b>ghost_update_</b></td></tr>
<tr class="separator:a303195ab5897d14ed598d29afd467f72"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a6850ed6380d2f194e0247723e4b71f23"><td class="memItemLeft" align="right" valign="top"><a id="a6850ed6380d2f194e0247723e4b71f23"></a>
StdVec&lt; <a class="el" href="namespace_s_p_h.html#abae56fd7f25f13487c7943ce4681d0ce">IndexVector</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>ghost_particles_</b></td></tr>
<tr class="separator:a6850ed6380d2f194e0247723e4b71f23"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_attribs_class_s_p_h_1_1_periodic_condition_in_axis_direction"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_class_s_p_h_1_1_periodic_condition_in_axis_direction')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="class_s_p_h_1_1_periodic_condition_in_axis_direction.html">SPH::PeriodicConditionInAxisDirection</a></td></tr>
<tr class="memitem:af9de88ec2111ca0193d7684156ae6997 inherit pro_attribs_class_s_p_h_1_1_periodic_condition_in_axis_direction"><td class="memItemLeft" align="right" valign="top"><a id="af9de88ec2111ca0193d7684156ae6997"></a>
Vecd&#160;</td><td class="memItemRight" valign="bottom"><b>periodic_translation_</b></td></tr>
<tr class="separator:af9de88ec2111ca0193d7684156ae6997 inherit pro_attribs_class_s_p_h_1_1_periodic_condition_in_axis_direction"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a393764d17cb7b7c66c322fc709c94ccd inherit pro_attribs_class_s_p_h_1_1_periodic_condition_in_axis_direction"><td class="memItemLeft" align="right" valign="top"><a id="a393764d17cb7b7c66c322fc709c94ccd"></a>
StdVec&lt; <a class="el" href="namespace_s_p_h.html#a54f9b375e654fcf04192f5a123495808">CellLists</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>bound_cells_</b></td></tr>
<tr class="separator:a393764d17cb7b7c66c322fc709c94ccd inherit pro_attribs_class_s_p_h_1_1_periodic_condition_in_axis_direction"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_methods_class_s_p_h_1_1_periodic_condition_in_axis_direction"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_class_s_p_h_1_1_periodic_condition_in_axis_direction')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="class_s_p_h_1_1_periodic_condition_in_axis_direction.html">SPH::PeriodicConditionInAxisDirection</a></td></tr>
<tr class="memitem:aa995fd29aad8e508d3926aab5b3b2197 inherit pro_methods_class_s_p_h_1_1_periodic_condition_in_axis_direction"><td class="memItemLeft" align="right" valign="top"><a id="aa995fd29aad8e508d3926aab5b3b2197"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>setPeriodicTranslation</b> (<a class="el" href="namespace_s_p_h.html#ad185cdeb05bdee76bf975cc50f1c15b7">BoundingBox</a> &amp;body_domain_bounds, <a class="el" href="classint.html">int</a> axis_direction)</td></tr>
<tr class="separator:aa995fd29aad8e508d3926aab5b3b2197 inherit pro_methods_class_s_p_h_1_1_periodic_condition_in_axis_direction"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The method imposing periodic boundary condition in an axis direction by using ghost particles. It includes three different steps, i.e. imposing periodic bounding, creating ghosts and update ghost state. The first step is carried out before update cell linked list and the second and third after the updating. If the exec or parallel_exec is called directly, error message will be given. Note that, currently, this class is not for periodic condition in combined directions, such as periodic condition in both x and y directions. </p>
</div><hr/>The documentation for this class was generated from the following file:<ul>
<li>SPHINXsys/src/shared/particle_dynamics/general_dynamics/<a class="el" href="general__dynamics_8h_source.html">general_dynamics.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>
